home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / gnu / amiga / gcc233.lha / info / gcc.info-2 (.txt) < prev    next >
GNU Info File  |  1992-12-29  |  48KB  |  922 lines

  1. This is Info file gcc.info, produced by Makeinfo-1.49 from the input
  2. file gcc.texi.
  3.    This file documents the use and the internals of the GNU compiler.
  4.    Copyright (C) 1988, 1989, 1992 Free Software Foundation, Inc.
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided also
  10. that the sections entitled "GNU General Public License" and "Protect
  11. Your Freedom--Fight `Look And Feel'" are included exactly as in the
  12. original, and provided that the entire resulting derived work is
  13. distributed under the terms of a permission notice identical to this
  14.    Permission is granted to copy and distribute translations of this
  15. manual into another language, under the above conditions for modified
  16. versions, except that the sections entitled "GNU General Public
  17. License" and "Protect Your Freedom--Fight `Look And Feel'", and this
  18. permission notice, may be included in translations approved by the Free
  19. Software Foundation instead of in the original English.
  20. File: gcc.info,  Node: Dialect Options,  Next: Warning Options,  Prev: Overall Options,  Up: Invoking GCC
  21. Options Controlling Dialect
  22. ===========================
  23.    The following options control the dialect of C or C++ that the
  24. compiler accepts:
  25. `-ansi'
  26.      Support all ANSI standard C programs.
  27.      This turns off certain features of GNU C that are incompatible
  28.      with ANSI C, such as the `asm', `inline' and `typeof' keywords, and
  29.      predefined macros such as `unix' and `vax' that identify the type
  30.      of system you are using.  It also enables the undesirable and
  31.      rarely used ANSI trigraph feature, and disallows `$' as part of
  32.      identifiers.
  33.      The alternate keywords `__asm__', `__extension__', `__inline__'
  34.      and `__typeof__' continue to work despite `-ansi'.  You would not
  35.      want to use them in an ANSI C program, of course, but it useful to
  36.      put them in header files that might be included in compilations
  37.      done with `-ansi'.  Alternate predefined macros such as `__unix__'
  38.      and `__vax__' are also available, with or without `-ansi'.
  39.      The `-ansi' option does not cause non-ANSI programs to be rejected
  40.      gratuitously.  For that, `-pedantic' is required in addition to
  41.      `-ansi'.  *Note Warning Options::.
  42.      The macro `__STRICT_ANSI__' is predefined when the `-ansi' option
  43.      is used.  Some header files may notice this macro and refrain from
  44.      declaring certain functions or defining certain macros that the
  45.      ANSI standard doesn't call for; this is to avoid interfering with
  46.      any programs that might use these names for other things.
  47.      The functions `alloca', `abort', `exit', and `_exit' are not
  48.      builtin functions when `-ansi' is used.
  49. `-fall-virtual'
  50.      Treat certain member functions as virtual, implicitly (C++ only). 
  51.      This applies to all member functions declared in the same class
  52.      with a "method-call" operator method (except for constructor
  53.      functions and `new' or `delete' member operators).  In effect, all
  54.      of these methods become "implicitly virtual."
  55.      This does not mean that all calls to these methods will be made
  56.      through the internal table of virtual functions.  There are some
  57.      circumstances under which it is obvious that a call to a given
  58.      virtual function can be made directly, and in these cases the
  59.      calls still go direct.
  60.      The effect of making all methods of a class with a declared
  61.      `operator->()()' implicitly virtual using `-fall-virtual' extends
  62.      also to all non-constructor methods of any class derived from such
  63.      a class.
  64. `-fdollars-in-identifiers'
  65.      Permit the use of `$' in identifiers (C++ only).  You can also use
  66.      `-fno-dollars-in-identifiers' to explicitly prohibit use of `$'. 
  67.      (GNU C++ allows `$' by default on some target systems but not
  68.      others.)
  69. `-fenum-int-equiv'
  70.      Permit implicit conversion of `int' to enumeration types (C++
  71.      only).  Normally GNU C++ allows conversion of `enum' to `int', but
  72.      not the other way around.
  73. `-fno-asm'
  74.      Do not recognize `asm', `inline' or `typeof' as a keyword.  These
  75.      words may then be used as identifiers.  You can use `__asm__',
  76.      `__inline__' and `__typeof__' instead. `-ansi' implies `-fno-asm'.
  77. `-fno-builtin'
  78.      Don't recognize built-in functions that do not begin with two
  79.      leading underscores. Currently, the functions affected include
  80.      `_exit', `abort', `abs', `alloca', `cos', `exit', `fabs', `labs',
  81.      `memcmp', `memcpy', `sin', `sqrt', `strcmp', `strcpy', and
  82.      `strlen'.
  83.      The `-ansi' option prevents `alloca' and `_exit' from being
  84.      builtin functions.
  85. `-fno-strict-prototype'
  86.      Treat a function declaration with no arguments, such as `int foo
  87.      ();', as C would treat it--as saying nothing about the number of
  88.      arguments or their types (C++ only).  Normally, such a declaration
  89.      in C++ means that the function `foo' takes no arguments.
  90. `-fthis-is-variable'
  91.      Permit assignment to `this' (C++ only).  The incorporation of
  92.      user-defined free store management into C++ has made assignment to
  93.      `this' an anachronism.  Therefore, by default it is invalid to
  94.      assign to `this' within a class member function.  However, for
  95.      backwards compatibility, you can make it valid with
  96.      `-fthis-is-variable'.
  97. `-trigraphs'
  98.      Support ANSI C trigraphs.  You don't want to know about this
  99.      brain-damage.  The `-ansi' option implies `-trigraphs'.
  100. `-traditional'
  101.      Attempt to support some aspects of traditional C compilers.
  102.      Specifically:
  103.         * All `extern' declarations take effect globally even if they
  104.           are written inside of a function definition.  This includes
  105.           implicit declarations of functions.
  106.         * The keywords `typeof', `inline', `signed', `const' and
  107.           `volatile' are not recognized.  (You can still use the
  108.           alternative keywords such as `__typeof__', `__inline__', and
  109.           so on.)
  110.         * Comparisons between pointers and integers are always allowed.
  111.         * Integer types `unsigned short' and `unsigned char' promote to
  112.           `unsigned int'.
  113.         * Out-of-range floating point literals are not an error.
  114.         * String "constants" are not necessarily constant; they are
  115.           stored in writable space, and identical looking constants are
  116.           allocated separately.  (This is the same as the effect of
  117.           `-fwritable-strings'.)
  118.         * All automatic variables not declared `register' are preserved
  119.           by `longjmp'.  Ordinarily, GNU C follows ANSI C: automatic
  120.           variables not declared `volatile' may be clobbered.
  121.         * In the preprocessor, comments convert to nothing at all,
  122.           rather than to a space.  This allows traditional token
  123.           concatenation.
  124.         * In the preprocessor, macro arguments are recognized within
  125.           string constants in a macro definition (and their values are
  126.           stringified, though without additional quote marks, when they
  127.           appear in such a context).  The preprocessor always considers
  128.           a string constant to end at a newline.
  129.         * The predefined macro `__STDC__' is not defined when you use
  130.           `-traditional', but `__GNUC__' is (since the GNU extensions
  131.           which `__GNUC__' indicates are not affected by
  132.           `-traditional').  If you need to write header files that work
  133.           differently depending on whether `-traditional' is in use, by
  134.           testing both of these predefined macros you can distinguish
  135.           four situations: GNU C, traditional GNU C, other ANSI C
  136.           compilers, and other old C compilers.
  137.      You may wish to use `-fno-builtin' as well as `-traditional' if
  138.      your program uses names that are normally GNU C builtin functions
  139.      for other purposes of its own.
  140. `-traditional-cpp'
  141.      Attempt to support some aspects of traditional C preprocessors.
  142.      This includes the last three items in the table immediately above,
  143.      but none of the other effects of `-traditional'.
  144. `-fcond-mismatch'
  145.      Allow conditional expressions with mismatched types in the second
  146.      and third arguments.  The value of such an expression is void.
  147. `-funsigned-char'
  148.      Let the type `char' be unsigned, like `unsigned char'.
  149.      Each kind of machine has a default for what `char' should be.  It
  150.      is either like `unsigned char' by default or like `signed char' by
  151.      default.
  152.      Ideally, a portable program should always use `signed char' or
  153.      `unsigned char' when it depends on the signedness of an object.
  154.      But many programs have been written to use plain `char' and expect
  155.      it to be signed, or expect it to be unsigned, depending on the
  156.      machines they were written for.  This option, and its inverse, let
  157.      you make such a program work with the opposite default.
  158.      The type `char' is always a distinct type from each of `signed
  159.      char' or `unsigned char', even though its behavior is always just
  160.      like one of those two.
  161. `-fsigned-char'
  162.      Let the type `char' be signed, like `signed char'.
  163.      Note that this is equivalent to `-fno-unsigned-char', which is the
  164.      negative form of `-funsigned-char'.  Likewise, `-fno-signed-char'
  165.      is equivalent to `-funsigned-char'.
  166. `-fsigned-bitfields'
  167. `-funsigned-bitfields'
  168. `-fno-signed-bitfields'
  169. `-fno-unsigned-bitfields'
  170.      These options control whether a bitfield is signed or unsigned,
  171.      when the declaration does not use either `signed' or `unsigned'. 
  172.      By default, such a bitfield is signed, because this is consistent:
  173.      the basic integer types such as `int' are signed types.
  174.      However, when `-traditional' is used, bitfields are all unsigned
  175.      no matter what.
  176. `-fwritable-strings'
  177.      Store string constants in the writable data segment and don't
  178.      uniquize them.  This is for compatibility with old programs which
  179.      assume they can write into string constants.  `-traditional' also
  180.      has this effect.
  181.      Writing into string constants is a very bad idea; "constants"
  182.      should be constant.
  183. File: gcc.info,  Node: Warning Options,  Next: Debugging Options,  Prev: Dialect Options,  Up: Invoking GCC
  184. Options to Request or Suppress Warnings
  185. =======================================
  186.    Warnings are diagnostic messages that report constructions which are
  187. not inherently erroneous but which are risky or suggest there may have
  188. been an error.
  189.    You can request many specific warnings with options beginning `-W',
  190. for example `-Wimplicit' to request warnings on implicit declarations. 
  191. Each of these specific warning options also has a negative form
  192. beginning `-Wno-' to turn off warnings; for example, `-Wno-implicit'. 
  193. This manual lists only one of the two forms, whichever is not the
  194. default.
  195.    These options control the amount and kinds of warnings produced by
  196. GNU CC:
  197. `-fsyntax-only'
  198.      Check the code for syntax errors, but don't emit any output.
  199.      Inhibit all warning messages.
  200. `-Wno-import'
  201.      Inhibit warning messages about the use of `#import'.
  202. `-pedantic'
  203.      Issue all the warnings demanded by strict ANSI standard C; reject
  204.      all programs that use forbidden extensions.
  205.      Valid ANSI standard C programs should compile properly with or
  206.      without this option (though a rare few will require `-ansi'). 
  207.      However, without this option, certain GNU extensions and
  208.      traditional C features are supported as well.  With this option,
  209.      they are rejected.
  210.      `-pedantic' does not cause warning messages for use of the
  211.      alternate keywords whose names begin and end with `__'.  Pedantic
  212.      warnings are also disabled in the expression that follows
  213.      `__extension__'.  However, only system header files should use
  214.      these escape routes; application programs should avoid them. *Note
  215.      Alternate Keywords::.
  216.      This option is not intended to be useful; it exists only to satisfy
  217.      pedants who would otherwise claim that GNU CC fails to support the
  218.      ANSI standard.
  219.      Some users try to use `-pedantic' to check programs for strict ANSI
  220.      C conformance.  They soon find that it does not do quite what they
  221.      want: it finds some non-ANSI practices, but not all--only those
  222.      for which ANSI C *requires* a diagnostic.
  223.      A feature to report any failure to conform to ANSI C might be
  224.      useful in some instances, but would require considerable
  225.      additional work and would be quite different from `-pedantic'.  We
  226.      recommend, rather, that users take advantage of the extensions of
  227.      GNU C and disregard the limitations of other compilers.  Aside
  228.      from certain supercomputers and obsolete small machines, there is
  229.      less and less reason ever to use any other C compiler other than
  230.      for bootstrapping GNU CC.
  231. `-pedantic-errors'
  232.      Like `-pedantic', except that errors are produced rather than
  233.      warnings.
  234.      Print extra warning messages for these events:
  235.         * A nonvolatile automatic variable might be changed by a call to
  236.           `longjmp'.  These warnings as well are possible only in
  237.           optimizing compilation.
  238.           The compiler sees only the calls to `setjmp'.  It cannot know
  239.           where `longjmp' will be called; in fact, a signal handler
  240.           could call it at any point in the code.  As a result, you may
  241.           get a warning even when there is in fact no problem because
  242.           `longjmp' cannot in fact be called at the place which would
  243.           cause a problem.
  244.         * A function can return either with or without a value. 
  245.           (Falling off the end of the function body is considered
  246.           returning without a value.)  For example, this function would
  247.           evoke such a warning:
  248.                foo (a)
  249.                {
  250.                  if (a > 0)
  251.                    return a;
  252.                }
  253.         * An expression-statement contains no side effects.
  254.         * An unsigned value is compared against zero with `>' or `<='.
  255.         * A comparison like `x<=y<=z' appears; this is equivalent to
  256.           `(x<=y ? 1 : 0) <= z', which is a different interpretation
  257.           from that of ordinary mathematical notation.
  258.         * Storage-class specifiers like `static' are not the first
  259.           things in a declaration.  According to the C Standard, this
  260.           usage is obsolescent.
  261.         * An aggregate has a partly bracketed initializer. For example,
  262.           the following code would evoke such a warning, because braces
  263.           are missing around the initializer for `x.h':
  264.                struct s { int f, g; };
  265.                struct t { struct s h; int i; };
  266.                struct t x = { 1, 2, 3 };
  267. `-Wenum-clash'
  268.      Warn about conversion between different enumeration types (C++
  269.      only).
  270. `-Wimplicit'
  271.      Warn whenever a function or parameter is implicitly declared.
  272. `-Wreturn-type'
  273.      Warn whenever a function is defined with a return-type that
  274.      defaults to `int'.  Also warn about any `return' statement with no
  275.      return-value in a function whose return-type is not `void'.
  276. `-Wunused'
  277.      Warn whenever a local variable is unused aside from its
  278.      declaration, whenever a function is declared static but never
  279.      defined, and whenever a statement computes a result that is
  280.      explicitly not used.
  281.      If you want to prevent a warning for a particular variable, you
  282.      can use this macro:
  283.           #define USE(var) \
  284.             static void * use_##var = (&use_##var, (void *) &var)
  285.           
  286.           USE (string);
  287. `-Wswitch'
  288.      Warn whenever a `switch' statement has an index of enumeral type
  289.      and lacks a `case' for one or more of the named codes of that
  290.      enumeration.  (The presence of a `default' label prevents this
  291.      warning.)  `case' labels outside the enumeration range also
  292.      provoke warnings when this option is used.
  293. `-Wcomment'
  294.      Warn whenever a comment-start sequence `/*' appears in a comment.
  295. `-Wtrigraphs'
  296.      Warn if any trigraphs are encountered (assuming they are enabled).
  297. `-Wformat'
  298.      Check calls to `printf' and `scanf', etc., to make sure that the
  299.      arguments supplied have types appropriate to the format string
  300.      specified.
  301. `-Wchar-subscripts'
  302.      Warn if an array subscript has type `char'.  This is a common cause
  303.      of error, as programmers often forget that this type is signed on
  304.      some machines.
  305. `-Wuninitialized'
  306.      An automatic variable is used without first being initialized.
  307.      These warnings are possible only in optimizing compilation,
  308.      because they require data flow information that is computed only
  309.      when optimizing.  If you don't specify `-O', you simply won't get
  310.      these warnings.
  311.      These warnings occur only for variables that are candidates for
  312.      register allocation.  Therefore, they do not occur for a variable
  313.      that is declared `volatile', or whose address is taken, or whose
  314.      size is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
  315.      structures, unions or arrays, even when they are in registers.
  316.      Note that there may be no warning about a variable that is used
  317.      only to compute a value that itself is never used, because such
  318.      computations may be deleted by data flow analysis before the
  319.      warnings are printed.
  320.      These warnings are made optional because GNU CC is not smart
  321.      enough to see all the reasons why the code might be correct
  322.      despite appearing to have an error.  Here is one example of how
  323.      this can happen:
  324.           {
  325.             int x;
  326.             switch (y)
  327.               {
  328.               case 1: x = 1;
  329.                 break;
  330.               case 2: x = 4;
  331.                 break;
  332.               case 3: x = 5;
  333.               }
  334.             foo (x);
  335.           }
  336.      If the value of `y' is always 1, 2 or 3, then `x' is always
  337.      initialized, but GNU CC doesn't know this.  Here is another common
  338.      case:
  339.           {
  340.             int save_y;
  341.             if (change_y) save_y = y, y = new_y;
  342.             ...
  343.             if (change_y) y = save_y;
  344.           }
  345.      This has no bug because `save_y' is used only if it is set.
  346.      Some spurious warnings can be avoided if you declare as `volatile'
  347.      all the functions you use that never return. *Note Function
  348.      Attributes::.
  349. `-Wparentheses'
  350.      Warn if parentheses are omitted in certain contexts.
  351. `-Wall'
  352.      All of the above `-W' options combined.  These are all the options
  353.      which pertain to usage that we recommend avoiding and that we
  354.      believe is easy to avoid, even in conjunction with macros.
  355.    The remaining `-W...' options are not implied by `-Wall' because
  356. they warn about constructions that we consider reasonable to use, on
  357. occasion, in clean programs.
  358. `-Wtraditional'
  359.      Warn about certain constructs that behave differently in
  360.      traditional and ANSI C.
  361.         * Macro arguments occurring within string constants in the
  362.           macro body. These would substitute the argument in
  363.           traditional C, but are part of the constant in ANSI C.
  364.         * A function declared external in one block and then used after
  365.           the end of the block.
  366.         * A `switch' statement has an operand of type `long'.
  367. `-Wshadow'
  368.      Warn whenever a local variable shadows another local variable.
  369. `-Wid-clash-LEN'
  370.      Warn whenever two distinct identifiers match in the first LEN
  371.      characters.  This may help you prepare a program that will compile
  372.      with certain obsolete, brain-damaged compilers.
  373. `-Wpointer-arith'
  374.      Warn about anything that depends on the "size of" a function type
  375.      or of `void'.  GNU C assigns these types a size of 1, for
  376.      convenience in calculations with `void *' pointers and pointers to
  377.      functions.
  378. `-Wcast-qual'
  379.      Warn whenever a pointer is cast so as to remove a type qualifier
  380.      from the target type.  For example, warn if a `const char *' is
  381.      cast to an ordinary `char *'.
  382. `-Wcast-align'
  383.      Warn whenever a pointer is cast such that the required alignment
  384.      of the target is increased.  For example, warn if a `char *' is
  385.      cast to an `int *' on machines where integers can only be accessed
  386.      at two- or four-byte boundaries.
  387. `-Wwrite-strings'
  388.      Give string constants the type `const char[LENGTH]' so that
  389.      copying the address of one into a non-`const' `char *' pointer
  390.      will get a warning.  These warnings will help you find at compile
  391.      time code that can try to write into a string constant, but only
  392.      if you have been very careful about using `const' in declarations
  393.      and prototypes.  Otherwise, it will just be a nuisance; this is
  394.      why we did not make `-Wall' request these warnings.
  395. `-Wconversion'
  396.      Warn if a prototype causes a type conversion that is different
  397.      from what would happen to the same argument in the absence of a
  398.      prototype.  This includes conversions of fixed point to floating
  399.      and vice versa, and conversions changing the width or signedness
  400.      of a fixed point argument except when the same as the default
  401.      promotion.
  402. `-Waggregate-return'
  403.      Warn if any functions that return structures or unions are defined
  404.      or called.  (In languages where you can return an array, this also
  405.      elicits a warning.)
  406. `-Wstrict-prototypes'
  407.      Warn if a function is declared or defined without specifying the
  408.      argument types.  (An old-style function definition is permitted
  409.      without a warning if preceded by a declaration which specifies the
  410.      argument types.)
  411. `-Wmissing-prototypes'
  412.      Warn if a global function is defined without a previous prototype
  413.      declaration.  This warning is issued even if the definition itself
  414.      provides a prototype.  The aim is to detect global functions that
  415.      fail to be declared in header files.
  416. `-Wredundant-decls'
  417.      Warn if anything is declared more than once in the same scope,
  418.      even in cases where multiple declaration is valid and changes
  419.      nothing.
  420. `-Wnested-externs'
  421.      Warn if an `extern' declaration is encountered within an function.
  422. `-Winline'
  423.      Warn if a function can not be inlined, and either it was declared
  424.      as inline, or else the `-finline-functions' option was given.
  425. `-Werror'
  426.      Make all warnings into errors.
  427. File: gcc.info,  Node: Debugging Options,  Next: Optimize Options,  Prev: Warning Options,  Up: Invoking GCC
  428. Options for Debugging Your Program or GNU CC
  429. ============================================
  430.    GNU CC has various special options that are used for debugging
  431. either your program or GCC:
  432.      Produce debugging information in the operating system's native
  433.      format (stabs, COFF, XCOFF, or DWARF).  GDB can work with this
  434.      debugging information.
  435.      On most systems that use stabs format, `-g' enables use of extra
  436.      debugging information that only GDB can use; this extra information
  437.      makes debugging work better in GDB but will probably make other
  438.      debuggers crash or refuse to read the program.  If you want to
  439.      control for certain whether to generate the extra information, use
  440.      `-gstabs+', `-gstabs', `-gxcoff+', `-gxcoff', `-gdwarf+', or
  441.      `-gdwarf' (see below).
  442.      Unlike most other C compilers, GNU CC allows you to use `-g' with
  443.      `-O'.  The shortcuts taken by optimized code may occasionally
  444.      produce surprising results: some variables you declared may not
  445.      exist at all; flow of control may briefly move where you did not
  446.      expect it; some statements may not be executed because they
  447.      compute constant results or their values were already at hand;
  448.      some statements may execute in different places because they were
  449.      moved out of loops.
  450.      Nevertheless it proves possible to debug optimized output.  This
  451.      makes it reasonable to use the optimizer for programs that might
  452.      have bugs.
  453.      The following options are useful when GNU CC is generated with the
  454.      capability for more than one debugging format.
  455. `-ggdb'
  456.      Produce debugging information in the native format (if that is
  457.      supported), including GDB extensions if at all possible.
  458. `-gstabs'
  459.      Produce debugging information in stabs format (if that is
  460.      supported), without GDB extensions.  This is the format used by
  461.      DBX on most BSD systems.
  462. `-gstabs+'
  463.      Produce debugging information in stabs format (if that is
  464.      supported), using GNU extensions understood only by the GNU
  465.      debugger (GDB).  The use of these extensions is likely to make
  466.      other debuggers crash or refuse to read the program.
  467. `-gcoff'
  468.      Produce debugging information in COFF format (if that is
  469.      supported). This is the format used by SDB on most System V
  470.      systems prior to System V Release 4.
  471. `-gxcoff'
  472.      Produce debugging information in XCOFF format (if that is
  473.      supported). This is the format used by the DBX debugger on IBM
  474.      RS/6000 systems.
  475. `-gxcoff+'
  476.      Produce debugging information in XCOFF format (if that is
  477.      supported), using GNU extensions understood only by the GNU
  478.      debugger (GDB).  The use of these extensions is likely to make
  479.      other debuggers crash or refuse to read the program.
  480. `-gdwarf'
  481.      Produce debugging information in DWARF format (if that is
  482.      supported). This is the format used by SDB on most System V
  483.      Release 4 systems.
  484. `-gdwarf+'
  485.      Produce debugging information in DWARF format (if that is
  486.      supported), using GNU extensions understood only by the GNU
  487.      debugger (GDB).  The use of these extensions is likely to make
  488.      other debuggers crash or refuse to read the program.
  489. `-gLEVEL'
  490. `-ggdbLEVEL'
  491. `-gstabsLEVEL'
  492. `-gcoffLEVEL'
  493. `-gxcoffLEVEL'
  494. `-gdwarfLEVEL'
  495.      Request debugging information and also use LEVEL to specify how
  496.      much information.  The default level is 2.
  497.      Level 1 produces minimal information, enough for making backtraces
  498.      in parts of the program that you don't plan to debug.  This
  499.      includes descriptions of functions and external variables, but no
  500.      information about local variables and no line numbers.
  501.      Level 3 includes extra information, such as all the macro
  502.      definitions present in the program.  Some debuggers support macro
  503.      expansion when you use `-g3'.
  504.      Generate extra code to write profile information suitable for the
  505.      analysis program `prof'.
  506. `-pg'
  507.      Generate extra code to write profile information suitable for the
  508.      analysis program `gprof'.
  509.      Generate extra code to write profile information for basic blocks,
  510.      which will record the number of times each basic block is executed.
  511.      This data could be analyzed by a program like `tcov'.  Note,
  512.      however, that the format of the data is not what `tcov' expects.
  513.      Eventually GNU `gprof' should be extended to process this data.
  514. `-dLETTERS'
  515.      Says to make debugging dumps during compilation at times specified
  516.      by LETTERS.  This is used for debugging the compiler.  The file
  517.      names for most of the dumps are made by appending a word to the
  518.      source file name (e.g.  `foo.c.rtl' or `foo.c.jump').  Here are the
  519.      possible letters for use in LETTERS, and their meanings:
  520.     `M'
  521.           Dump all macro definitions, at the end of preprocessing, and
  522.           write no output.
  523.     `N'
  524.           Dump all macro names, at the end of preprocessing.
  525.     `D'
  526.           Dump all macro definitions, at the end of preprocessing, in
  527.           addition to normal output.
  528.     `y'
  529.           Dump debugging information during parsing, to standard error.
  530.     `r'
  531.           Dump after RTL generation, to `FILE.rtl'.
  532.     `x'
  533.           Just generate RTL for a function instead of compiling it. 
  534.           Usually used with `r'.
  535.     `j'
  536.           Dump after first jump optimization, to `FILE.jump'.
  537.     `s'
  538.           Dump after CSE (including the jump optimization that sometimes
  539.           follows CSE), to `FILE.cse'.
  540.     `L'
  541.           Dump after loop optimization, to `FILE.loop'.
  542.     `t'
  543.           Dump after the second CSE pass (including the jump
  544.           optimization that sometimes follows CSE), to `FILE.cse2'.
  545.     `f'
  546.           Dump after flow analysis, to `FILE.flow'.
  547.     `c'
  548.           Dump after instruction combination, to `FILE.combine'.
  549.     `S'
  550.           Dump after the first instruction scheduling pass, to
  551.           `FILE.sched'.
  552.     `l'
  553.           Dump after local register allocation, to
  554.           `FILE.lreg'.
  555.     `g'
  556.           Dump after global register allocation, to
  557.           `FILE.greg'.
  558.     `R'
  559.           Dump after the second instruction scheduling pass, to
  560.           `FILE.sched2'.
  561.     `J'
  562.           Dump after last jump optimization, to `FILE.jump2'.
  563.     `d'
  564.           Dump after delayed branch scheduling, to `FILE.dbr'.
  565.     `k'
  566.           Dump after conversion from registers to stack, to
  567.           `FILE.stack'.
  568.     `a'
  569.           Produce all the dumps listed above.
  570.     `m'
  571.           Print statistics on memory usage, at the end of the run, to
  572.           standard error.
  573.     `p'
  574.           Annotate the assembler output with a comment indicating which
  575.           pattern and alternative was used.
  576. `-fpretend-float'
  577.      When running a cross-compiler, pretend that the target machine
  578.      uses the same floating point format as the host machine.  This
  579.      causes incorrect output of the actual floating constants, but the
  580.      actual instruction sequence will probably be the same as GNU CC
  581.      would make when running on the target machine.
  582. `-save-temps'
  583.      Store the usual "temporary" intermediate files permanently; place
  584.      them in the current directory and name them based on the source
  585.      file.  Thus, compiling `foo.c' with `-c -save-temps' would produce
  586.      files `foo.i' and `foo.s', as well as `foo.o'.
  587. File: gcc.info,  Node: Optimize Options,  Next: Preprocessor Options,  Prev: Debugging Options,  Up: Invoking GCC
  588. Options That Control Optimization
  589. =================================
  590.    These options control various sorts of optimizations:
  591. `-O1'
  592.      Optimize.  Optimizing compilation takes somewhat more time, and a
  593.      lot more memory for a large function.
  594.      Without `-O', the compiler's goal is to reduce the cost of
  595.      compilation and to make debugging produce the expected results.
  596.      Statements are independent: if you stop the program with a
  597.      breakpoint between statements, you can then assign a new value to
  598.      any variable or change the program counter to any other statement
  599.      in the function and get exactly the results you would expect from
  600.      the source code.
  601.      Without `-O', only variables declared `register' are allocated in
  602.      registers.  The resulting compiled code is a little worse than
  603.      produced by PCC without `-O'.
  604.      With `-O', the compiler tries to reduce code size and execution
  605.      time.
  606.      When `-O' is specified, `-fthread-jumps' and `-fdelayed-branch'
  607.      are turned on.  On some machines other flags may also be turned on.
  608. `-O2'
  609.      Optimize even more.  Nearly all supported optimizations that do not
  610.      involve a space-speed tradeoff are performed.  As compared to `-O',
  611.      this option increases both compilation time and the performance of
  612.      the generated code.
  613.      `-O2' turns on all `-fFLAG' options that enable more optimization,
  614.      except for `-funroll-loops', `-funroll-all-loops' and
  615.      `-fomit-frame-pointer'.
  616. `-O0'
  617.      Do not optimize.
  618.      If you use multiple `-O' options, with or without level numbers,
  619.      the last such option is the one that is effective.
  620.    Options of the form `-fFLAG' specify machine-independent flags. 
  621. Most flags have both positive and negative forms; the negative form of
  622. `-ffoo' would be `-fno-foo'.  In the table below, only one of the forms
  623. is listed--the one which is not the default. You can figure out the
  624. other form by either removing `no-' or adding it.
  625. `-ffloat-store'
  626.      Do not store floating point variables in registers, and inhibit
  627.      other options that might change whether a floating point value is
  628.      taken from a register or memory.
  629.      This option prevents undesirable excess precision on machines such
  630.      as the 68000 where the floating registers (of the 68881) keep more
  631.      precision than a `double' is supposed to have.  For most programs,
  632.      the excess precision does only good, but a few programs rely on the
  633.      precise definition of IEEE floating point.  Use `-ffloat-store' for
  634.      such programs.
  635. `-fno-defer-pop'
  636.      Always pop the arguments to each function call as soon as that
  637.      function returns.  For machines which must pop arguments after a
  638.      function call, the compiler normally lets arguments accumulate on
  639.      the stack for several function calls and pops them all at once.
  640. `-fforce-mem'
  641.      Force memory operands to be copied into registers before doing
  642.      arithmetic on them.  This may produce better code by making all
  643.      memory references potential common subexpressions.  When they are
  644.      not common subexpressions, instruction combination should
  645.      eliminate the separate register-load.  I am interested in hearing
  646.      about the difference this makes.
  647. `-fforce-addr'
  648.      Force memory address constants to be copied into registers before
  649.      doing arithmetic on them.  This may produce better code just as
  650.      `-fforce-mem' may.  I am interested in hearing about the
  651.      difference this makes.
  652. `-fomit-frame-pointer'
  653.      Don't keep the frame pointer in a register for functions that
  654.      don't need one.  This avoids the instructions to save, set up and
  655.      restore frame pointers; it also makes an extra register available
  656.      in many functions.  *It also makes debugging impossible on some
  657.      machines.*
  658.      On some machines, such as the Vax, this flag has no effect, because
  659.      the standard calling sequence automatically handles the frame
  660.      pointer and nothing is saved by pretending it doesn't exist.  The
  661.      machine-description macro `FRAME_POINTER_REQUIRED' controls
  662.      whether a target machine supports this flag.  *Note Registers::.
  663. `-fno-inline'
  664.      Don't pay attention to the `inline' keyword.  Normally this option
  665.      is used to keep the compiler from expanding any functions inline.
  666.      Note that if you are not optimizing, no functions can be expanded
  667.      inline.
  668. `-finline-functions'
  669.      Integrate all simple functions into their callers.  The compiler
  670.      heuristically decides which functions are simple enough to be worth
  671.      integrating in this way.
  672.      If all calls to a given function are integrated, and the function
  673.      is declared `static', then the function is normally not output as
  674.      assembler code in its own right.
  675. `-fkeep-inline-functions'
  676.      Even if all calls to a given function are integrated, and the
  677.      function is declared `static', nevertheless output a separate
  678.      run-time callable version of the function.
  679. `-fno-default-inline'
  680.      Don't make member functions inline by default merely because they
  681.      are defined inside the class scope (C++ only).
  682. `-fno-function-cse'
  683.      Do not put function addresses in registers; make each instruction
  684.      that calls a constant function contain the function's address
  685.      explicitly.
  686.      This option results in less efficient code, but some strange hacks
  687.      that alter the assembler output may be confused by the
  688.      optimizations performed when this option is not used.
  689. `-ffast-math'
  690.      This option allows GCC to violate some ANSI or IEEE
  691.      rules/specifications in the interest of optimizing code for speed.
  692.       For example, it allows the compiler to assume arguments to the
  693.      `sqrt' function are non-negative numbers.
  694.      This option should never be turned on by any `-O' option since it
  695.      can result in incorrect output for programs which depend on an
  696.      exact implementation of IEEE or ANSI rules/specifications for math
  697.      functions.
  698. `-felide-constructors'
  699.      Elide constructors when this seems plausible (C++ only).  With this
  700.      option, GNU C++ initializes `y' directly from the call to `foo'
  701.      without going through a temporary in the following code:
  702.           A foo ();
  703.           A y = foo ();
  704.      Without this option, GNU C++ first initializes `y' by calling the
  705.      appropriate constructor for type `A'; then assigns the result of
  706.      `foo' to a temporary; and, finally, replaces the initial value of
  707.      `y' with the temporary.
  708.      The default behavior (`-fno-elide-constructors') is specified by
  709.      the draft ANSI C++ standard.  If your program's constructors have
  710.      side effects, `-felide-constructors' can change your program's
  711.      behavior, since some constructor calls may be omitted.
  712. `-fmemoize-lookups'
  713. `-fsave-memoized'
  714.      Use heuristics to compile faster (C++ only).  These heuristics are
  715.      not enabled by default, since they are only effective for certain
  716.      input files.  Other input files compile more slowly.
  717.      The first time the compiler must build a call to a member function
  718.      (or reference to a data member), it must (1) determine whether the
  719.      class implements member functions of that name; (2) resolve which
  720.      member function to call (which involves figuring out what sorts of
  721.      type conversions need to be made); and (3) check the visibility of
  722.      the member function to the caller.  All of this adds up to slower
  723.      compilation. Normally, the second time a call is made to that
  724.      member function (or reference to that data member), it must go
  725.      through the same lengthy process again.  This means that code like
  726.      this
  727.           cout << "This " << p << " has " << n << " legs.\n";
  728.      makes six passes through all three steps.  By using a software
  729.      cache, a "hit" significantly reduces this cost.  Unfortunately,
  730.      using the cache introduces another layer of mechanisms which must
  731.      be implemented, and so incurs its own overhead. 
  732.      `-fmemoize-lookups' enables the software cache.
  733.      Because access privileges (visibility) to members and member
  734.      functions may differ from one function context to the next, G++
  735.      may need to flush the cache.  With the `-fmemoize-lookups' flag,
  736.      the cache is flushed after every function that is compiled.  The
  737.      `-fsave-memoized' flag enables the same software cache, but when
  738.      the compiler determines that the context of the last function
  739.      compiled would yield the same access privileges of the next
  740.      function to compile, it preserves the cache. This is most helpful
  741.      when defining many member functions for the same class: with the
  742.      exception of member functions which are friends of other classes,
  743.      each member function has exactly the same access privileges as
  744.      every other, and the cache need not be flushed.
  745.    The following options control specific optimizations.  The `-O2'
  746. option turns on all of these optimizations except `-funroll-loops' and
  747. `-funroll-all-loops'.  The `-O' option usually turns on the
  748. `-fthread-jumps' and `-fdelayed-branch' options, but specific machines
  749. may change the default optimizations.
  750.    You can use the following flags in the rare cases when "fine-tuning"
  751. of optimizations to be performed is desired.
  752. `-fstrength-reduce'
  753.      Perform the optimizations of loop strength reduction and
  754.      elimination of iteration variables.
  755. `-fthread-jumps'
  756.      Perform optimizations where we check to see if a jump branches to a
  757.      location where another comparison subsumed by the first is found. 
  758.      If so, the first branch is redirected to either the destination of
  759.      the second branch or a point immediately following it, depending
  760.      on whether the condition is known to be true or false.
  761. `-fcse-follow-jumps'
  762.      In common subexpression elimination, scan through jump instructions
  763.      when the target of the jump is not reached by any other path.  For
  764.      example, when CSE encounters an `if' statement with an `else'
  765.      clause, CSE will follow the jump when the condition tested is
  766.      false.
  767. `-fcse-skip-blocks'
  768.      This is similar to `-fcse-follow-jumps', but causes CSE to follow
  769.      jumps which conditionally skip over blocks.  When CSE encounters a
  770.      simple `if' statement with no else clause, `-fcse-skip-blocks'
  771.      causes CSE to follow the jump around the body of the `if'.
  772. `-frerun-cse-after-loop'
  773.      Re-run common subexpression elimination after loop optimizations
  774.      has been performed.
  775. `-fexpensive-optimizations'
  776.      Perform a number of minor optimizations that are relatively
  777.      expensive.
  778. `-fdelayed-branch'
  779.      If supported for the target machine, attempt to reorder
  780.      instructions to exploit instruction slots available after delayed
  781.      branch instructions.
  782. `-fschedule-insns'
  783.      If supported for the target machine, attempt to reorder
  784.      instructions to eliminate execution stalls due to required data
  785.      being unavailable.  This helps machines that have slow floating
  786.      point or memory load instructions by allowing other instructions
  787.      to be issued until the result of the load or floating point
  788.      instruction is required.
  789. `-fschedule-insns2'
  790.      Similar to `-fschedule-insns', but requests an additional pass of
  791.      instruction scheduling after register allocation has been done. 
  792.      This is especially useful on machines with a relatively small
  793.      number of registers and where memory load instructions take more
  794.      than one cycle.
  795. `-fcaller-saves'
  796.      Enable values to be allocated in registers that will be clobbered
  797.      by function calls, by emitting extra instructions to save and
  798.      restore the registers around such calls.  Such allocation is done
  799.      only when it seems to result in better code than would otherwise
  800.      be produced.
  801.      This option is enabled by default on certain machines, usually
  802.      those which have no call-preserved registers to use instead.
  803. `-funroll-loops'
  804.      Perform the optimization of loop unrolling.  This is only done for
  805.      loops whose number of iterations can be determined at compile time
  806.      or run time. `-funroll-loop' implies `-fstrength-reduce' and
  807.      `-frerun-cse-after-loop'.
  808. `-funroll-all-loops'
  809.      Perform the optimization of loop unrolling.  This is done for all
  810.      loops and usually makes programs run more slowly. 
  811.      `-funroll-all-loops' implies `-fstrength-reduce' and
  812.      `-frerun-cse-after-loop'.
  813. `-fno-peephole'
  814.      Disable any machine-specific peephole optimizations.
  815. File: gcc.info,  Node: Preprocessor Options,  Next: Assembler Options,  Prev: Optimize Options,  Up: Invoking GCC
  816. Options Controlling the Preprocessor
  817. ====================================
  818.    These options control the C preprocessor, which is run on each C
  819. source file before actual compilation.
  820.    If you use the `-E' option, nothing is done except preprocessing.
  821. Some of these options make sense only together with `-E' because they
  822. cause the preprocessor output to be unsuitable for actual compilation.
  823. `-include FILE'
  824.      Process FILE as input before processing the regular input file. In
  825.      effect, the contents of FILE are compiled first.  Any `-D' and
  826.      `-U' options on the command line are always processed before
  827.      `-include FILE', regardless of the order in which they are
  828.      written.  All the `-include' and `-imacros' options are processed
  829.      in the order in which they are written.
  830. `-imacros FILE'
  831.      Process FILE as input, discarding the resulting output, before
  832.      processing the regular input file.  Because the output generated
  833.      from FILE is discarded, the only effect of `-imacros FILE' is to
  834.      make the macros defined in FILE available for use in the main
  835.      input.
  836.      Any `-D' and `-U' options on the command line are always processed
  837.      before `-imacros FILE', regardless of the order in which they are
  838.      written.  All the `-include' and `-imacros' options are processed
  839.      in the order in which they are written.
  840. `-nostdinc'
  841.      Do not search the standard system directories for header files. 
  842.      Only the directories you have specified with `-I' options (and the
  843.      current directory, if appropriate) are searched.  *Note Directory
  844.      Options::, for information on `-I'.
  845.      By using both `-nostdinc' and `-I-', you can limit the include-file
  846.      search path to only those directories you specify explicitly.
  847. `-nostdinc++'
  848.      Do not search for header files in the C++-specific standard
  849.      directories, but do still search the other standard directories.
  850.      (This option is used when building `libg++'.)
  851. `-undef'
  852.      Do not predefine any nonstandard macros.  (Including architecture
  853.      flags).
  854.      Run only the C preprocessor.  Preprocess all the C source files
  855.      specified and output the results to standard output or to the
  856.      specified output file.
  857.      Tell the preprocessor not to discard comments.  Used with the `-E'
  858.      option.
  859.      Tell the preprocessor not to generate `#line' commands. Used with
  860.      the `-E' option.
  861.      Tell the preprocessor to output a rule suitable for `make'
  862.      describing the dependencies of each object file.  For each source
  863.      file, the preprocessor outputs one `make'-rule whose target is the
  864.      object file name for that source file and whose dependencies are
  865.      all the files `#include'd in it.  This rule may be a single line
  866.      or may be continued with `\'-newline if it is long.  The list of
  867.      rules is printed on standard output instead of the preprocessed C
  868.      program.
  869.      `-M' implies `-E'.
  870.      Another way to specify output of a `make' rule is by setting the
  871.      environment variable `DEPENDENCIES_OUTPUT' (*note Environment
  872.      Variables::.).
  873. `-MM'
  874.      Like `-M' but the output mentions only the user header files
  875.      included with `#include "FILE"'.  System header files included
  876.      with `#include <FILE>' are omitted.
  877. `-MD'
  878.      Like `-M' but the dependency information is written to files with
  879.      names made by replacing `.o' with `.d' at the end of the output
  880.      file names.  This is in addition to compiling the input files as
  881.      specified--`-MD' does not inhibit ordinary compilation the way
  882.      `-M' does.
  883.      The Mach utility `md' can be used to merge the `.d' files into a
  884.      single dependency file suitable for using with the `make' command.
  885. `-MMD'
  886.      Like `-MD' except mention only user header files, not system
  887.      header files.
  888.      Print the name of each header file used, in addition to other
  889.      normal activities.
  890. `-AQUESTION(ANSWER)'
  891.      Assert the answer ANSWER for QUESTION, in case it is tested with a
  892.      preprocessor conditional such as `#if #QUESTION(ANSWER)'.  `-A-'
  893.      disables the standard assertions that normally describe the target
  894.      machine.
  895. `-DMACRO'
  896.      Define macro MACRO with the string `1' as its definition.
  897. `-DMACRO=DEFN'
  898.      Define macro MACRO as DEFN.  All instances of `-D' on the command
  899.      line are processed before any `-U' options.
  900. `-UMACRO'
  901.      Undefine macro MACRO.  `-U' options are evaluated after all `-D'
  902.      options, but before any `-include' and `-imacros' options.
  903. `-dM'
  904.      Tell the preprocessor to output only a list of the macro
  905.      definitions that are in effect at the end of preprocessing.  Used
  906.      with the `-E' option.
  907. `-dD'
  908.      Tell the preprocessing to pass all macro definitions into the
  909.      output, in their proper sequence in the rest of the output.
  910. `-dN'
  911.      Like `-dD' except that the macro arguments and contents are
  912.      omitted. Only `#define NAME' is included in the output.
  913. `-trigraphs'
  914.      Support ANSI C trigraphs.  You don't want to know about this
  915.      brain-damage.  The `-ansi' option also has this effect.
  916. File: gcc.info,  Node: Assembler Options,  Next: Link Options,  Prev: Preprocessor Options,  Up: Invoking GCC
  917. Passing Options to the Assembler
  918. ================================
  919. `-Wa,OPTION'
  920.      Pass OPTION as an option to the assembler.  If OPTION contains
  921.      commas, it is split into multiple options at the commas.
  922.